home *** CD-ROM | disk | FTP | other *** search
/ Dominator 3 / Dominator 3.bin / doom1 / utils2 / randoom / randoom.man < prev    next >
Encoding:
Text File  |  1994-02-20  |  14.5 KB  |  331 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  9.  
  10.  
  11.  
  12.  
  13.           NAME
  14.                RanDOOM - A smart object placement randomization utility for
  15.                DOOM. 
  16.  
  17.           SYNOPSIS
  18.                RanDOOM [WADfile][-C<seed>][-M<n>][-W<filename>][-G]
  19.                [-LE<j>M<k>]
  20.  
  21.                RanDOOM [Wadfile] -D
  22.  
  23.           DESCRIPTION
  24.                RanDOOM is a utility which will randomize the placement of
  25.                objects in the DOOM playfield. Additionally, RanDOOM has
  26.                some smarts about the manner in which it will randomize
  27.                things - it's designed to never leave you with a pillar
  28.                blocking the exit, or a keycard on the opposite side of the
  29.                door from where you start, or to erase all the DEATHMATCH
  30.                warp-in spots with other objects (preventing DEATHMATCH
  31.                network play), or to replace the endgame bosses with other
  32.                objects (thus preventing the completion of an episode). In
  33.                short, RanDOOM will always leave you with a playable level.
  34.                RanDOOM is also user configurable - it allows you to specify
  35.                the proportion of total objects a given object will comprise
  36.                via a customizable object weighting scheme. This allows you
  37.                to tailor RanDOOM's randomizing to your personal taste
  38.                (and/or masochism ;-).
  39.  
  40.                At the end of each run, RanDOOM will append to a file called
  41.                RANDOOM.LOG in the current directory information from that
  42.                run. Currently the seed value used for the random number
  43.                generator is saved for future reference.
  44.  
  45.  
  46.           OPTIONS
  47.                WAD_file_name - Use this path to the WAD file. If no
  48.                filename is specified, doom.wad in the current directory is
  49.                used.
  50.  
  51.                -D - Restores the WAD file to its default state. When the -D
  52.                switch is specified, all other switches are ignored. NOTE:
  53.                The restoration function can only restore changes made by
  54.                RanDOOM. If you have made changes with another randomizing
  55.                or map editing utility, RanDOOM will probably be unable to
  56.                undo those changes. Mix and match WAD utilities at your own
  57.                risk!
  58.  
  59.                -C<seed> - Use a single ASCII character as the seed value
  60.  
  61.                                           1
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  77.  
  78.  
  79.                for the pseudorandom number generator. The character is
  80.                case-sensitive, so 'K' and 'k' yield different seed values.
  81.                Alternatively, -C accepts a positive integer number
  82.                [0..65535] as the seed value. If no -C parameter is
  83.                specified, a seed value is taken based on the current system
  84.                time.
  85.  
  86.                -G - Produce a graphic display of the item randomization
  87.                process on the screen (VGA required). This switch was added
  88.                to aid in debugging the selection algorithms. You may find
  89.                it interesting to watch. 
  90.  
  91.                -M<n> - Use randomization mode n, where n is a single digit
  92.                [0-9]. Currently only three randomization modes (0, 1 and 2)
  93.                are supported. If no -M parameter is specified, mode 0 is
  94.                used by default. 
  95.  
  96.                -LE<j>M<k> - Process Episode j, Map k only, where 1 <= j <=
  97.                3, 1 <= k <= 9. Multiple -L switches may be specified on a
  98.                single command line. If no level is specified, all levels
  99.                are processed by default.
  100.  
  101.                All randomization modes attempt to avoid potential problems
  102.                which would arise if a completely random replacement of
  103.                objects were made. Such problems include immovable objects,
  104.                such as a pillar or tree root, blocking a switch or doorway;
  105.                monsters becoming "stuck in the wall" (or tangled up in each
  106.                other!) and unable to move or fight; the replacement of
  107.                player warp-in spots with other objects, preventing one or
  108.                both forms of network play; the movement of keycards or
  109.                skulls to new locations which then become inaccessible; etc.
  110.                To achieve this, RanDOOM maintains lots of data about the
  111.                objects and the DOOM level maps, such as the locations of
  112.                objects, their relative sizes in three dimensions, their
  113.                types, whether the player can move them, kill them, or pick
  114.                them up, the locations of walls, the amount of "headroom" in
  115.                a given area, and so forth. From this information, RanDOOM
  116.                is able, in most cases, to calculate whether or not a given
  117.                object will "fit" into a given location in the map without
  118.                conflicts.  
  119.  
  120.                Randomization mode 0 takes the objects currently placed on
  121.                each level and rearranges them. No objects are added,
  122.                subtracted, or replaced - if a given level contains 2 Barons
  123.                of Hell, 12 Imps, 32 blue health vials, and a chainsaw, then
  124.                the modified level will also contain 2 Barons of Hell, 12
  125.                Imps, 32 blue health vials, and one chainsaw, rearranged in
  126.                random order.
  127.  
  128.  
  129.                                           2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  145.  
  146.  
  147.                Randomization mode 1 replaces "nonessential" objects with
  148.                other randomly selected objects from the entire range of
  149.                available objects. This randomization mode may place objects
  150.                into a level which would not normally appear there, e.g. M1
  151.                may place Cacodemons in the Hangar level. Those items which
  152.                are needed to complete the level, such as keycards or level
  153.                bosses, remain in their original locations.
  154.  
  155.                Randomization mode 2 does the same things as mode 1 with the
  156.                addition of weight factors for replaceable objects. These
  157.                weights are user adjustable (via the weight file specified
  158.                using the -W switch) to allow a relative increase or
  159.                decrease in the number of a given item inserted in the game.
  160.                Thus, items with higher weights have a higher probability of
  161.                being selected. NOTE: If the -M2 switch is specified, the -W
  162.                switch (see below) must also be specified. 
  163.  
  164.                Randomization mode 3 improves on mode 2 by using a "best
  165.                fit" algortihm to approximate the item distribution
  166.                requested by the user (via the weight file) as closely as
  167.                possible. The items to be placed are sorted and placed in
  168.                order from largest to smallest. This prevents a fairly large
  169.                space which could potentially hold a larger object from
  170.                having a smaller object placed into it instead and
  171.                consequently allows optimal object placements. Because not
  172.                all items will fit into all areas without sticking or other
  173.                conflicts, the exact distribution requested may not be
  174.                possible. For example, a distribution of 100% Spider demons
  175.                would be utterly impossible to provide. As with mode 2, mode
  176.                3 requires that a valid weight file be specified on the
  177.                command line with the -W switch (described below).
  178.  
  179.                NOTE: With randomization modes 1, 2 and 3 ALL objects will
  180.                appear at ALL FOUR skill levels as well as during network
  181.                play; there will be no variation in the number or types of
  182.                objects between "Hey, Not Too Rough" and "Ultra Violence." 
  183.  
  184.                -W<filename> - Use item weight factors from file <filename>
  185.                in randomization modes 2 and 3. The weight file is a flat
  186.                ASCII text file consisting of a series of <itemname>
  187.                <weight> pairs, one pair per line. <itemname> must be one of
  188.                the predefined names listed in the sample weight file
  189.                (randoom.w), while <weight> must be a floating point value
  190.                greater than or equal to 0.0. In general, the larger the
  191.                weight value, the more occurrences of that object RanDOOM
  192.                will put into the game. There are some exceptions, most
  193.                notably with the larger objects. Because RanDOOM will only
  194.                place an item if it will "fit," some hard-to-place items
  195.                will have a lower effective weight than that specified in
  196.  
  197.                                           3
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  213.  
  214.  
  215.                the weight file. Take the Spider Demon, for example. This
  216.                sucker is so large it gets stuck just about anywhere. Out of
  217.                the hundreds of available item spots, there may be only one
  218.                or two locations where the Spider would be able to function.
  219.                Thus, even though it's number may come up via the weighted
  220.                selection scheme, its placement may still be prevented. If
  221.                an object is chosen which is too large for the available
  222.                space, another item is chosen until one is found which can
  223.                be safely placed into the current location. 
  224.  
  225.                Some comments about speed: Those of you who have used
  226.            earlier versions of RanDOOM will notice that 1.55 takes
  227.                longer to process the WAD file than did its predecessors.
  228.            This is due to the fact that 1.55 does a lot more work than
  229.                earlier versions, most of it 2-D geometric calculations
  230.                (such as the distances from objects to walls for collision
  231.                detection). After trying several different approaches to the
  232.                "monster stuck in the wall" problem, the method currently
  233.                employed was the best tradeoff in terms of speed and
  234.                accuracy I've found so far. Although RanDOOM makes extensive
  235.                use of integer and fixed-point math and '386-specific
  236.                instructions to speed the many calculations, it still takes
  237.                time to run (several minutes on a 20MHz 386SX test-dog
  238.                system). Of course, any system capable of running DOOM
  239.                adequately will have absolutely no problems with RanDOOM -
  240.                it breezes right along on my 486/33. 
  241.  
  242.           EXAMPLES
  243.                RanDOOM
  244.                     Display a brief usage synopsis.
  245.  
  246.                RanDOOM -Ck -M1 
  247.                     Rearrange levels using randomization mode 1 and random
  248.                     seed character 'k'.
  249.  
  250.                RanDOOM -M0
  251.                     Rearrange levels using randomization mode 0 and random
  252.                     seed based on the system time.
  253.  
  254.                RanDOOM -D
  255.                     Restore all objects in the WAD file to their default
  256.                     positions. 
  257.  
  258.                RanDOOM -M2 -Wc:\doom\randoom.w -C23456
  259.                     Rearrange levels using mode 2 with weights given in the
  260.                     file "c:\doom\randoom.w" and using the integer 23456 as
  261.                     the random number seed value.
  262.  
  263.                RanDOOM c:\doom\doom.wad -CT -G -LE1M1 -LE2M1
  264.  
  265.                                           4
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.           RanDOOM (1)           DOOM Operating System           RanDOOM (1)
  281.  
  282.  
  283.                     Rearrange levels E1M1 and E2M1 in WAD file
  284.                     c:\doom\doom.wad using randomization mode 0, seed
  285.                     character 'T', and display the object placements
  286.                     graphically.
  287.  
  288.           NOTICES
  289.                This software is copyright 1994 ASRE. You are free to use
  290.                and distribute this software provided that no modifications
  291.                are made to nor derivative works produced from it and that
  292.                no fees are charged for its distribution or use. Although
  293.                RanDOOM has been thoroughly tested, it is not guaranteed to
  294.                be completely free of bugs. Do I even need to mention that
  295.                you should back up your WAD file before running this
  296.                program?
  297.  
  298.           ACKNOWLEDGEMENTS
  299.                The ASRE would like to acknowledge the kind assistance of
  300.                many volunteers who offered their time, effort, and
  301.                suggestions. Your input has allowed RanDOOM to continue to
  302.                improve and become an even greater benefit to DOOM players
  303.                everywhere. Special thanks to: Barry Bloom and Scott Braley
  304.                for their hard work in optimizing the size settings for the
  305.                monsters; Chris Gregg for his kind assistance in coming up
  306.                with additional items to add; and many, many others, whose
  307.                names would easily double the size of this document were I
  308.                to include them all, for suggesting improvements, new
  309.                algorithms, new features, and other enhancements.
  310.  
  311.           BUGS
  312.                I welcome your comments, suggestions, and bug reports. Input
  313.                from users like you has made RanDOOM into the fun and useful
  314.                utility you see before you today, so don't please don't
  315.                hesitate to let your virtual voice be heard. Please email
  316.                any bug reports and/or comments to tmkk@uiuc.edu. For bug
  317.                reports, please include the following information in your
  318.                message: 
  319.  
  320.                     The version of RanDOOM you're running,
  321.                     The version of DOOM you're running,
  322.                     The command line switches you used,
  323.                     The random number seed value you used,
  324.                     And a description of the problem.
  325.  
  326.                The object placement algorithm may still occasionally
  327.                misplace objects, allowing them to become stuck either in a
  328.                wall or in each other. Occurrences of such sticking are now
  329.                extremely rare, especially when compared with earlier
  330.                versions of RanDOOM.
  331.  
  332.  
  333.                                           5
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.